API Documentation
FunctionParameter.h
1 // FunctionParameter.h
3 //
5 
6 namespace nkScripts
7 {
12  {
14  void* _userData = nullptr ;
16  } ;
17 }
18 
19 namespace nkScripts
20 {
24  struct FunctionParameter final
25  {
26  // Arguments
30  union
31  {
32  bool _valBool ;
33  int _valInt ;
34  float _valFloat ;
35  double _valDouble ;
36  nkMemory::String _valString ;
37  UserTypeHolder _valUser ;
38  ScriptObjectReference _valScriptObject ;
39  } ;
40 
42 
43  // Functions
53  explicit FunctionParameter (bool val) ;
59  explicit FunctionParameter (int val) ;
65  explicit FunctionParameter (float val) ;
71  explicit FunctionParameter (double val) ;
77  FunctionParameter (const char* val) ;
91  FunctionParameter (void* val, const nkMemory::StringView& userTypeName, bool scriptOwner) ;
97  FunctionParameter (const ScriptObjectReference& scriptObjectReference) ;
108 
109  // Utilities
126 
133 
138  } ;
139 }
nkScripts::FunctionParameter::FunctionParameter
FunctionParameter(const ScriptObjectReference &scriptObjectReference)
nkScripts
Encompasses all API of component NilkinsScripts.
Definition: Environment.h:7
nkScripts::FunctionParameter::prepareForScriptObjectReference
void prepareForScriptObjectReference()
nkScripts::FunctionParameter::FunctionParameter
FunctionParameter(float val)
nkScripts::FunctionParameter::VOID
static FunctionParameter VOID
Definition: FunctionParameter.h:137
nkScripts::FunctionParameter::FunctionParameter
FunctionParameter(double val)
nkScripts::FunctionParameter::FunctionParameter
FunctionParameter(const FunctionParameter &other)
nkScripts::FunctionParameter::FunctionParameter
FunctionParameter(int val)
nkScripts::FunctionParameter
A function parameter, used within the stack of arguments.
Definition: FunctionParameter.h:25
nkScripts::ScriptObjectReference
A reference over an object in the scripting environment.
Definition: ScriptObjectReference.h:30
nkScripts::UserTypeHolder::_userData
void * _userData
The user data pointer attached.
Definition: FunctionParameter.h:14
nkScripts::FunctionParameter::_type
FUNCTION_PARAMETER_TYPE _type
The actual type of the variable held.
Definition: FunctionParameter.h:41
nkScripts::UserTypeHolder::_objectRef
ScriptObjectView _objectRef
If parameter is a USER_DATA, it will provide a view that can be converted to a reference if needed.
Definition: FunctionParameter.h:15
nkScripts::FunctionParameter::FunctionParameter
FunctionParameter(void *val, const nkMemory::StringView &userTypeName, bool scriptOwner)
nkMemory::String
Class holding information about a string, with ownership over the data.
Definition: String.h:22
nkScripts::UserTypeHolder
Holds information about a user type parameter.
Definition: FunctionParameter.h:12
nkMemory::StringView
Class holding information about a string, with no ownership over the data.
Definition: StringView.h:22
nkScripts::FunctionParameter::FunctionParameter
FunctionParameter(bool val)
nkScripts::FunctionParameter::FunctionParameter
FunctionParameter(const char *val)
nkScripts::FunctionParameter::prepareForInternalType
void prepareForInternalType()
nkScripts::FunctionParameter::FunctionParameter
FunctionParameter()
nkScripts::ScriptObjectView
A view over an object in the scripting environment.
Definition: ScriptObjectView.h:16
nkScripts::FunctionParameter::prepareForUserType
void prepareForUserType()
nkScripts::FUNCTION_PARAMETER_TYPE
FUNCTION_PARAMETER_TYPE
Describes a variable type.
Definition: FunctionParameterType.h:12
nkScripts::FunctionParameter::operator=
FunctionParameter & operator=(const FunctionParameter &other)
nkScripts::FunctionParameter::prepareForString
void prepareForString()
nkScripts::FunctionParameter::~FunctionParameter
~FunctionParameter()
nkScripts::FunctionParameter::FunctionParameter
FunctionParameter(const nkMemory::StringView &val)
nkScripts::UserTypeHolder::_userTypeName
nkMemory::String _userTypeName
The user type name of the variable referenced.
Definition: FunctionParameter.h:13